Skip to content

docs: Update metrics procedures for automated Prometheus resource management#3092

Closed
tolusha wants to merge 1 commit into
eclipse-che:mainfrom
tolusha:docs/automated-prometheus-management-che-operator-2117
Closed

docs: Update metrics procedures for automated Prometheus resource management#3092
tolusha wants to merge 1 commit into
eclipse-che:mainfrom
tolusha:docs/automated-prometheus-management-che-operator-2117

Conversation

@tolusha
Copy link
Copy Markdown
Contributor

@tolusha tolusha commented May 11, 2026

What does this pull request change?

This PR updates the existing monitoring documentation to reflect that the Che Operator now automatically manages Prometheus resources (ServiceMonitor, Role, RoleBinding) for both Che Server and DevWorkspace Operator metrics collection.

Updated articles:

  • modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc - Removed manual ServiceMonitor/RBAC creation steps, documented automatic management
  • modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc - Removed manual ServiceMonitor/RBAC creation steps, documented automatic management
  • modules/administration-guide/partials/proc_enabling-and-exposing-che-metrics.adoc - Added documentation for the new spec.devEnvironments.metrics.enable field for DevWorkspace Operator metrics

Key changes:

  • Removed manual creation instructions for ServiceMonitor, Role, and RoleBinding resources
  • Added notes that the Che Operator automatically manages these Prometheus resources
  • Documented the new CRD field spec.devEnvironments.metrics.enable (defaults to true)
  • Updated prerequisites to mention Prometheus Operator requirement
  • Improved verification steps to check operator-created resources

What issues does this pull request fix or reference?

eclipse-che/che-operator#2117

Specify the version of the product this pull request applies to

next

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

…agement

Update documentation to reflect that the Che Operator now automatically
manages Prometheus resources (ServiceMonitor, Role, RoleBinding) for both
Che Server and DevWorkspace Operator metrics collection.

Changes:
- Remove manual ServiceMonitor/RBAC creation steps from collection procedures
- Add note about automatic resource management by the operator
- Document new spec.devEnvironments.metrics.enable field for DWO metrics
- Update prerequisites to mention Prometheus Operator requirement
- Improve verification steps to check operator-created resources

Related: eclipse-che/che-operator#2117
@github-actions
Copy link
Copy Markdown

⚡️ Deploying pull request preview...

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

Click here to review and test in web IDE: Contribute

@tolusha tolusha closed this May 11, 2026
@tolusha tolusha deleted the docs/automated-prometheus-management-che-operator-2117 branch May 11, 2026 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant